Reference: Display Filters: EMail
Move Up Move to Top
Contents: Filter Overview User Interface & Options
Example Variables
Filter Overview This display filter searches for email addresses and creates clickable objects that may be used to send mail to the listed email address.

Back to Top

User Interface The user interface for this filter looks like this:

The available configuration options are:

  • Multimedia Action - This is an action from the Multimedia Actions list that will be invoked when the email address is clicked. The multimedia type is application/X-email. The multimedia action may be any user defined action; for example, to send the article text to an email program such as YAM.

  • Font - If non-null, this font is used to display the email addresses.

  • Color - If selected, this color is used to display email addresses.

  • Style - The text style for displayed email addresses.

  • Selected Col - This color is used to display email addresses when they are pressed using the mouse.

Back to Top

Example Here is an example of a clickable email address.

When pressed, the text will change to the selected color and the associated multimedia action will be executed. Email addresses in the article body are also clickable.

Back to Top

Variables The following variables, in addition to the standard group, article, and project variables, are available to multimedia actions using this filter:

Variable NameDescription
File When used in a multimedia action for a clickable email address, this variable will be set to a filename which contains the article text. By default this is the full header and body of the article, but the following suffixies can be used:

  • :Head - The file will contain only the header information.
  • :Body - The file will contain only the body, but no headers.
  • :HdBd - The file will contain both the header and the body of the article. This is the default.
  • :Q - The body of the article will be quoted.

For example, referencing the variable ${File:Body:Q} would specify a file containing the quoted body of the article, with no header. This is useful for passing the indicated text to an external program.

email Used in a multimedia action, the email variable contains the email address that was clicked on.